home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 42 / Amiga Format AFCD42 (Issue 126, Aug 1999).iso / -serious- / programming / other / gui4cli / ext / gcsound / gcsound.readme < prev    next >
Text File  |  1999-05-14  |  4KB  |  127 lines
  1.  
  2.    ==========================================================
  3.    >>>>> GCSound - 8SVX sample player (mono only for now)
  4.    ==========================================================
  5.  
  6.    GCSound is a 8SVX simple sample player which can be controlled
  7.    from Gui4Cli (v3.6+) or from an ARexx program.
  8.  
  9.    You just run it, without any arguments (at the moment) and
  10.    it will load itself, create a public message port named 
  11.    "gcsound" (note the lower case) and sit around waiting for 
  12.    Gui4Cli or ARexx messages.
  13.  
  14.    Many samples can be loaded and played at will. If the sample
  15.    size is over 64k, it will be played directly from the hard
  16.    drive. You can have as many samples as you want loaded (note
  17.    that they will consume *chip* memory - maximum 64k each) and 
  18.    play up to 4 of them simuiltaneously.
  19.  
  20.    These are the commands it will understand :
  21.  
  22.    *       LOAD    <SampleFile> <Alias>
  23.  
  24.    Will load the sample into memory. <SampleFile> must be the
  25.    full path and file name of the sample, and <Alias> is a name
  26.    you give to it with which you can refer to it in other
  27.    commands. This could be the plain file name for example.
  28.    If the sample is over 64k, only the first 64k will be loaded.
  29.    The rest will be read from disk when needed.
  30.  
  31.    ex:
  32.    Address "gcsound"
  33.    'Load DH0:samples/mysample mysample'
  34.  
  35.    *       PLAY    <alias> [<times/0> <volume> <speed/-1>]
  36.  
  37.    This command will start to play an already loaded sample.
  38.    <Alias> is the name you gave to the sample. 
  39.  
  40.    You may also give the <times> you want it played (note 0 means 
  41.    - play forever), the <volume> (1-64) and the speed (125 - 1000
  42.    or -1 for default speed). If you don't give these, the sample 
  43.    will be played forever, at it's default volume and speed.
  44.  
  45.    *       UNLOAD  <alias/"">
  46.  
  47.    Will unload a loaded sample, freeing it's memory. If it's
  48.    playing, it will be aborted. If you do not give a sample name
  49.    then *all* samples will be aborted and unloaded.
  50.  
  51.    *       STOP    <alias/"">
  52.  
  53.    Will stop the given sample, if it's playing. Again, if you do
  54.    not give a sample name *all* samples currently playing will be 
  55.    stopped.
  56.  
  57.    *       SOUND   <SampleFile> [<times/0> <volume> <speed/-1>]
  58.  
  59.    This is like the Load and Play commands combined. It will
  60.    load the given <SampleFile> (full path), play it and when
  61.    finished, unload it.
  62.  
  63.    *       VOLUME  <alias> <1-64>
  64.  
  65.    With this you can change the volume of a loaded sample. 
  66.    This can be done whether the sample is playing or not.
  67.  
  68.    *       SPEED   <alias> <125-1000>
  69.  
  70.    Changes the speed of a loaded sample (while playing or not).
  71.  
  72.    *       TIMES   <alias> <times/0>
  73.  
  74.    Changes the times that a loaded sample will be played. 
  75.    Currently, this only works for large samples (i.e. the
  76.    ones being played directly from the hard drive)
  77.    Note that 0 means forever.
  78.  
  79.    *       QUIT
  80.  
  81.    Will abort all samples playing, unload everything and
  82.    quit.
  83.  
  84.    *       INFO    <alias>
  85.  
  86.    This command will return 2 numbers : the volume and the
  87.    speed of the given sample. From Gui4Cli, this can be accessed
  88.    through the $$Call.ret or $$RexxRet internal variables
  89.    depending on whether you used Call or SendRexx.
  90.  
  91.    If sent from an actual ARexx program, they will be stored
  92.    in arexx's RESULT variable.
  93.  
  94.    ==========================================================
  95.  
  96.    Behaviour :
  97.  
  98.    GCSound uses a user count system so that it may be accessed
  99.    by many outside programs. When you start up the program, it
  100.    will check if it's already running (i.e. if the gcsound port
  101.    exists) and if it is it will send it a message to increase 
  102.    the users counter.
  103.  
  104.    When you send it a quit command, it will decrease the users 
  105.    counter and will *not* quit until all other programs using it 
  106.    it have also told it to quit.
  107.  
  108.    This means that for each time you run the program you must
  109.    also send a respective quit command. You may get it stranded 
  110.    sometimes by running it too many times.. - just send it quit 
  111.    commands until you get a "host environment not found" error..
  112.  
  113.    ==========================================================
  114.  
  115.    Author    D. Keletsekis 
  116.    Email    dck@hol.gr
  117.    WWW        http:users.hol.gr/~dck/gcmain.htm
  118.    Status    FreeWare
  119.    Date        October 98
  120.    
  121.    ==========================================================
  122.  
  123.  
  124.  
  125.  
  126.  
  127.